API Documentation

The RO API can be used to retrieve data from the various tables within the RO application with the purpose of integrating the data with other tools or systems. Certain data elements can also be modified or added via the API.

The documentation is available within the swagger links below:

Stage: https://www.shimbonda.com/api/docs/

Production: https://rv.roinnovation.com/api/docs/

Access

Use of the RO API requires a client ID and a client secret, which are different for both stage and production. They will be provided separately once you have engaged on a project to access the API. Please reach out to your CSM for API access.

Available APIs

Data Export

The data export allows extraction of the various levels of all data in the RO system.

Note: As these calls are data intensive, we ask that they be made outside of U.S business hours. Also note that data warehouse data is re-aggregated at RO around 11PM ET daily, so we would recommend that these calls be made after that time.

• GET /public/dataexport/metaextensionlevels - Retrieves a list of Meta Extension Levels, these can be passed on to dataexport endpoints for Base and NVP data.

• POST /public/dataexport/basedata - Returns the base data for a given Meta Extension Level.

• GET /public/dataexport/dd - Returns a data dictionary for each type of data to be returned.

• POST /public/dataexport/nvp - Returns the name-value pair (NVP) data for additional information about a given level of data.

  Note: If a new field is added to the screen, this data will be reflected in the NVP data.

Assets

Assets allows to get data for the Content area of RO.

• GET /public/assets - Retrieves all assets and associated data elements

• GET /public/assets/{assetID}/rating – Retrieves rating for a specific asset

• GET /public/assets/contentAsset/{contentAssetId} – Retrieves data elements for specific assets

Nominations

• GET /public/nominations/{nominationID} – Retrieves data for a specific Nomination

• DELETE /public/nominations/{nominationID} – Deletes a specific Nomination

• GET /public/nominations/NominationsIDs – Retrieves all Nomination IDs

• PUT /public/nominations – Override existing Nominations

• POST /public/nominations - Creates new Nominations

• POST /public/nominations/ChangeNominationsStatus – Update Nomination Status

• POST /public/nominations/ChangeNominationsAssignee – Update Nomination Assignee

OAuth

• POST /oauth – Acquire OAuth token for API calls

PInfluitive

• POST /public/influtive/hook/{key} – Receives a WebHook event from Influitive

PSearch

• GET /public/search/{searchID} - Returns search data for a requested search, including filters

• DELETE /public/search/{searchID} – Deletes an existing searchID

• PATCH /public/search/{searchID} - Modifies an existing search criteria

• GET /public/search/{searchID}/page/{pageNumber} – Returns data for a specific page

• GET /public/search/CustomerEditPortal/{divisionId} – Returns data for a specific customer

• POST /public/search – Create a search

• GET /public/search/keywords/{term} – Find related search terms

Ratings

• POST /public/rating/save – Provide a rating for a specific asset

Requests

• GET /public/requests/RequestIds – Retrieves all RequestID’s

• POST /public/requests – Create a request

• GET /public/requests/metadata – Get Request Metadata

• GET /public/requests/approvals – Get pending approvals for the current user

• GET /public/requests/{requestID}/notes – Get all notes for a specific request

• POST /public/requests/{requestID}/notes – Create a note for a specific request

• POST /public/requests/bulk – Create requests in bulk

• POST /public/requests/complete/{requestID} – Complete a specific request

• GET /public/requests/{requestID} – Retrieve details of a specific request

• GET /public/requests/approvals/{requestID} – Retrieve approval data for a specific request

• POST /public/requests/approval – Provide an approval for a specific request

• POST /public/requests/ChangeRequestsAssignee – Change the assignee for a specific request

• DELETE /public/requests/notes/{noteID} – Delete a specific note

• GET /public/requests/references/{requestID} – retrieve all reference details of a specific request

Rewards

• GET /public/rewards – Retrieve details about the different types of rewards

• POST /public/rewards – Create new customer or contact reward entry

• GET /public/rewards/details – Retrieve reward details for a customer/contact

SalesWins

• GET /public/saleswins/SaleswinsIds – Retrieves all Saleswins ID’s

• POST /public/saleswins/bulkassign – Bulk assign Saleswins to a specific user

• GET /public/saleswins/{saleswinId} – Retrieves all the details for a specific Saleswin

• DELETE /public/saleswins/{saleswinID} – Delete a specific saleswin

• POST /public/saleswins/save – Create a Saleswin

• POST /public/saleswins/draft – Create a draft status Saleswin

• POST /public/saleswins/BulkStatusUpdate – Update the statuses of Saleswins in bulk

Spotlights

• DELETE /public/spotlights/DeleteSpotlight/{spotlightID} – Deletes a specific Spotlight

• GET /public/spotlights – Retrieve a list of spotlights based on filter criteria

• PUT /public/spotlights/save – Modify an existing Spotlight

• POST /public/spotlights/save – Create a new Spotlight

• PUT /public/spotlights/saveandsend – Modify and send an existing Spotlight

• POST /public/spotlights/saveandsend – Create and send a Spotlight

• GET /public/spotlights/templates/all – Retrieve the Spotlight email templates

• GET /public/spotlights/{spotlightID}/history/invitee/{inviteeID} – Retrieve invitee history details

• GET /public/spotlights/{spotlightID}/history/asset/{assetID} – Retrieve asset usage details

• POST /public/spotlights/send – Send an existing Spotlight

• POST /public/spotlights/{spotlightID}/resend/{inviteeID} – Resend a Spotlight to a specific invitee

• GET /public/spotlights/{spotlightID} – Retrieve details of a specific Spotlight

• GET /public/spotlights/templates/spotlight – Retrieve all Spotlight templates

Tasks

• GET /public/tasks/GetTaskDetails/{taskId} – Retrieves details of a specific Task

• GET /public/tasks – Retrieve all Tasks based on a filter criteria

• POST /public/tasks/BulkAssign – Bulk assign Tasks to a specific user